docs(readme): refresh for 15.0.0 (human edit) by khaliqgant · Pull Request #2008 · AgentWorkforce/relay

khaliqgant · 2026-10-27T23:26:15Z

Draft for a human rewrite of the README. It's kept separate from code PRs on purpose.

The commit here is only two factual corrections:

relaycast-engine is published for every platform since engine 11.1.0, so "when published for your platform" is removed.
The npm paragraph: npm installs both agent-relay and relay, and since feat(cli): relay init downloads the standalone Relaycast engine #2006 relay init downloads relaycast-engine into ~/.agentworkforce/relay/bin, not only the broker.

Left for the human edit

relay after install.sh: done. fix(install): also install the short relay launcher #2009 merged, so install.sh creates relay too, and the table's launcher row now mentions it.
Released version: Getting Started describes 15.0.0 (relay init, single install dir, guided setup), but latest and install.sh install 14.0.0 until 15.0.0 is released. Merge this with or after the 15.0.0 release, or mention @next meanwhile.
Opening of Getting Started: it says "the easiest way is Agent Relay Cloud", while the steps below are local-first with no account needed. Decide which comes first.
Top copy and sections: Messaging, Integrations, Shared Sessions and Flows read as intended? Typos: "teammates agents", "Learn how write a flow", "lets be honest".
Shared Sessions MCP: agent-relay mcp --sessions-only still exists, but check it against the planned CLI command cut.
Badges: they point at @agent-relay/sdk, not the agent-relay CLI.
Quickstart: read docs/quickstart.md alongside, since the README links to it for flags and hosted/self-hosted.

🤖 Generated with Claude Code

^{Need help on this PR? Tag @codesmith-bot with what you need.}

Agent Relay sessions

claude session 5a4f854b · opened via gh pr create · last active 2026-10-28
claude session 8ab900cc · contributor · ran gh pr commands · last active 2026-10-31

Update (2026-10-30), still a draft for the human edit

Main is merged in, and Getting Started now has the flow verified end to end this week:

relay init sets up the detected tools for message injection. Run it in a project folder, not ~. Find agent names with relay agent list. The old "message codex-<your-folder>" was wrong: names also include the session title.
Working with teammates: relay init --hosted, then each teammate runs relay init --key '<key>'.
Which sessions join: Codex app, VS Code, Conductor, local Claude desktop sessions, Muse and similar join. Cloud Claude sessions, Claude Desktop chat, Cursor Composer, and sessions in ~ or temp folders don't.
Session history: the init core doesn't upload transcripts, and the desktop app follows its own sharing rules.
Undo: --uninstall and --stop.

Still for the human edit:

Release dependency: the plain relay init (no prompts) and relay init --key commands land with relay#2028 in 15.0.0-next.8. Until then, relay init asks three questions and teammates use relay init --url https://cast.agentrelay.com --key … --name …. Merge this with or after a release that has fix(cli): frictionless relay init; teammates join with relay init --key #2028.
Unverified rows: the Codex app, VS Code, Conductor and Claude desktop rows in "Which sessions join" haven't been tested against the relay init core yet.
Agent discovery: relay#2032 installs a messaging skill so agents can find each other without being told. Mention it if that ships.
Consistency: the opening, voice and length are yours. The new sections follow the docs site's Getting started page (agentrelay.com#255).

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

coderabbitai · 2026-10-27T23:26:23Z

Caution

Review failed

The pull request is closed.

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

…in, history Draft content for the human edit, matching the verified hackathon flow: - relay init sets up detected tools and injection; run it in a project folder; find agents with relay agent list - teammates: relay init --hosted, then relay init --key '<key>' - which sessions join and which do not (cloud Claude, Claude Desktop chat, Cursor Composer, home/temp folders) - transcripts are not uploaded by the init core; the desktop app's rules - undo with --uninstall / --stop Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

chatgpt-codex-connector · 2026-10-31T07:46:36Z

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review	Status	Commit	Review trigger
📝 Code Review	✅ Completed 2026-10-31T07:47:41.347161Z	`18edfc2`	Draft marked ready

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

devin-ai-integration

🔍 Devin Review: 2 flags

Not posted on this PR by your GitHub settings — view them in Devin Review. (Configure)

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 18edfc2ab8

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

greptile-apps · 2026-10-31T07:48:50Z

Confidence Score: 4/5

[Low impact] The changes affect README readers, not runtime behavior.

The README appears safe to merge, with a non-blocking improvement to the undo instructions.

Findings

Undo leaves processes running ▶

Fix with agent prompt

### Issue 1
README.md:85
`relay init --uninstall` removes tool settings and turns off message injection, but leaves the local server and core running. Readers following these instructions may think setup has been fully undone. Also mention `relay init --stop` so they can stop the background processes.

```suggestion
Undo with `relay init --uninstall`, then run `relay init --stop` to stop the local server and core. Transcripts stay on your machine. More in the [quickstart](docs/quickstart.md).
```

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Summary

Refreshes the README’s installation details and shortens Getting Started.

The install table shows both CLI launchers and the local server.
npm commands and shared Relay binaries live in different folders.
The README guides readers from local setup to agent and teammate use.

Acknowledged or deferred by khaliqgant: release timing and command availability; unverified desktop-related session support; possible agent-discovery guidance; opening copy, voice, length, and typos; the planned MCP command cut; and SDK badges. These were not reported again.

_{Reviews (1) · Last reviewed commit: "docs(readme): keep Getting started short..." · Reviewed by Greptile}

greptile-apps · 2026-10-31T07:48:53Z

-relay agent register alice && relay agent register bob
-relay message dm send bob "hello" --as alice
-```
+Undo with `relay init --uninstall`. Transcripts stay on your machine. More in the [quickstart](docs/quickstart.md).


Undo leaves processes running

relay init --uninstall removes tool settings and turns off message injection, but leaves the local server and core running. Readers following these instructions may think setup has been fully undone. Also mention relay init --stop so they can stop the background processes.

Suggested change

Undo with `relay init --uninstall`. Transcripts stay on your machine. More in the [quickstart](docs/quickstart.md).

Undo with `relay init --uninstall`, then run `relay init --stop` to stop the local server and core. Transcripts stay on your machine. More in the [quickstart](docs/quickstart.md).

Prompt To Fix With AI

This is a comment left during a code review. Path: README.md Line: 85 Comment: **Undo leaves processes running** `relay init --uninstall` removes tool settings and turns off message injection, but leaves the local server and core running. Readers following these instructions may think setup has been fully undone. Also mention `relay init --stop` so they can stop the background processes. ```suggestion Undo with `relay init --uninstall`, then run `relay init --stop` to stop the local server and core. Transcripts stay on your machine. More in the [quickstart](docs/quickstart.md). ``` --- For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

docs(readme): correct the engine and npm install notes

8dc68ff

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

docs(readme): note the relay launcher install.sh now creates

b582214

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>

khaliqgant mentioned this pull request Oct 28, 2026

fix(cli): relay init — portable MCP command, real Codex project trust, workspace key out of git #2011

Merged

kjgbot and others added 3 commits October 30, 2026 17:26

Merge remote-tracking branch 'origin/main' into docs/readme-refresh

6d6725f

docs(readme): keep Getting started short; desktop app as the upgrade

18edfc2

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

khaliqgant marked this pull request as ready for review October 31, 2026 07:46

khaliqgant requested a review from willwashburn as a code owner October 31, 2026 07:46

kjgbot self-requested a review October 31, 2026 07:46

kjgbot approved these changes Oct 31, 2026

View reviewed changes

devin-ai-integration Bot reviewed Oct 31, 2026

View reviewed changes

chatgpt-codex-connector Bot reviewed Oct 31, 2026

View reviewed changes

Comment thread README.md Resolved

kjgbot merged commit 79ddf39 into main Oct 31, 2026
33 of 34 checks passed

greptile-apps Bot reviewed Oct 31, 2026

View reviewed changes

Navigation Menu

Repository navigation

docs(readme): refresh for 15.0.0 (human edit) - #2008

docs(readme): refresh for 15.0.0 (human edit)#2008
kjgbot merged 5 commits into
mainfrom
docs/readme-refresh

khaliqgant commented Oct 27, 2026 •

edited by agent-relay-code Bot

Loading

Uh oh!

coderabbitai Bot commented Oct 27, 2026 •

edited

Loading

Review failed

Uh oh!

chatgpt-codex-connector Bot commented Oct 31, 2026 •

edited

Loading

Uh oh!

devin-ai-integration Bot left a comment

Uh oh!

chatgpt-codex-connector Bot left a comment

Uh oh!

Uh oh!

Uh oh!

greptile-apps Bot commented Oct 31, 2026 •

edited

Loading

Summary

Uh oh!

greptile-apps Bot Oct 31, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	Undo with `relay init --uninstall`. Transcripts stay on your machine. More in the [quickstart](docs/quickstart.md).
	Undo with `relay init --uninstall`, then run `relay init --stop` to stop the local server and core. Transcripts stay on your machine. More in the [quickstart](docs/quickstart.md).

Conversation

khaliqgant commented Oct 27, 2026 • edited by agent-relay-code Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Left for the human edit

Update (2026-10-30), still a draft for the human edit

Uh oh!

coderabbitai Bot commented Oct 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Uh oh!

chatgpt-codex-connector Bot commented Oct 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codex Review Summary

Uh oh!

devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

🔍 Devin Review: 2 flags

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

greptile-apps Bot commented Oct 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Confidence Score: 4/5

Findings

Summary

Uh oh!

greptile-apps Bot Oct 31, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

khaliqgant commented Oct 27, 2026 •

edited by agent-relay-code Bot

Loading

coderabbitai Bot commented Oct 27, 2026 •

edited

Loading

chatgpt-codex-connector Bot commented Oct 31, 2026 •

edited

Loading

greptile-apps Bot commented Oct 31, 2026 •

edited

Loading